RCG B2C Commerce Experience API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| map-b2c-customer-to-cim | B2C Customer Mapping |
| map-b2c-order-to-cim | B2C Order Mapping |
| map-inventory-query-response | Inventory Response Mapping |
map-b2c-customer-to-cim
B2C Customer Mapping
Source:
./src/main/resources/dwl/map-b2c-customer-to-cim.dwl
Mapping Tables
Maps B2C customer profiles to CIM Customer format
| CIM | B2C | Description | |
|---|---|---|---|
| id | masterId | The id of the customer role | |
| partyRoleType | Customer | The type of party role | |
| party.id | null | The id of the individual party | |
| party.partyType | Individual | The type of party | |
| party.personName | firstName lastName | The full name of the individual | |
| party.firstName | firstName | The first name of the individual | |
| party.lastName | lastName | The last name of the individual | |
| party.contactPoints.id | null | Hardcoded Id to null | |
| party.contactPoints.name | addressId | The individual Address Id | |
| party.contactPoints.contactPointType | ContactPointAddress | Hardcoded contactPointType to ContactPointAddress | |
| party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| party.contactPoints.addressLine1 | address1 | The Address of individual | |
| party.contactPoints.addressLine2 | address2 | The Address of individual | |
| party.contactPoints.cityName | city | The city name of individual | |
| party.contactPoints.stateProvinceName | state | The state name of individual | |
| party.contactPoints.countryName | country | The country name of individual | |
| party.contactPoints.postalCodeText | postalCode | The postalCode name of individual | |
| party.contactPoints.id | null | Hardcoded Id to null | |
| party.contactPoints.name | addressId | The customer Address Id | |
| party.contactPoints.contactPointType | ContactPointEmail | Hardcoded contactPointType to ContactPointEmail | |
| party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| party.contactPoints.emailAddress | The email address of individual | ||
| party.contactPoints.id | null | Hardcoded Id to null | |
| party.contactPoints.name | addressId | The customer Address Id | |
| party.contactPoints.contactPointType | ContactPointPhone | Hardcoded contactPointType to ContactPointPhone | |
| party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| party.contactPoints.telephoneNumber | contactPhone | The phone number of the individual | |
| customerNumber | customerNumber | The Individual number of the individual | |
| customerStatus | ACTIVE | The status of the customer | |
| externalIds.id | null | Hardcoded Id to null | |
| externalIds.externalId | customerNumber | The external Id of the SALESFORCE_B2C | |
| externalIds.externalIdType | SALESFORCE_B2C | The externalIdtype of SALESFORCE_B2C | |
| externalIds.status | VALID | The status of the customer | |
| auditInfo.createdBy | createdBy | The Individual created by user | |
| auditInfo.updatedBy | updatedBy | The individual last updated user | |
| auditInfo.updatedDate | updatedDate | The last Modified date of the individual | |
| auditInfo.createdDate | createdDate | The creation Date of the individual | |
| auditInfo.isDeleted | false | Indicates whether or not the entity has been deleted defaulted to false |
map-b2c-order-to-cim
B2C Order Mapping
Source:
./src/main/resources/dwl/map-b2c-order-to-cim.dwl
Mapping Tables
Maps B2C sales orders to CIM format
| CIM | B2C | Description | |
|---|---|---|---|
| id | masterId | The id of the order | |
| name | SalesOrder | The name of the order | |
| orderNumber | orderNumber | The order number | |
| requestedStartDate | createdDate | The order created date | |
| salesOrderType | ORDER | The order type | |
| salesOrderStatus | orderStatus | The order status | |
| orderCurrency | USD | The currency of this order | |
| orderCustomer.id | null | Hardcoded Id to null | |
| orderCustomer.partyRoleType | Customer | The type of party role | |
| orderCustomer.party.id | null | The id of the individual party | |
| orderCustomer.party.partyType | Individual | The type of party | |
| orderCustomer.party.personName | customerName | The full name of the individual | |
| orderCustomer.party.contactPoints.id | null | Hardcoded Id to null | |
| orderCustomer.party.contactPoints.name | BillingAddress | Hardcoded as Billing Address | |
| orderCustomer.party.contactPoints.contactPointType | ContactPointAddress | Hardcoded contactPointType to ContactPointAddress | |
| orderCustomer.party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| orderCustomer.party.contactPoints.addressLine1 | billingAddress1 | The Address of individual | |
| orderCustomer.party.contactPoints.addressLine2 | billingAddress2 | The Address of individual | |
| orderCustomer.party.contactPoints.cityName | billingCity | The city name of individual | |
| orderCustomer.party.contactPoints.stateProvinceName | billingRegion | The state name of individual | |
| orderCustomer.party.contactPoints.countryName | billingCountry | The country name of individual | |
| orderCustomer.party.contactPoints.postalCodeText | billingPostalCode | The postalCode name of individual | |
| orderCustomer.party.contactPoints.id | null | Hardcoded Id to null | |
| orderCustomer.party.contactPoints.name | ShippingAddress | Hardcoded as Shipping Address | |
| orderCustomer.party.contactPoints.contactPointType | ContactPointAddress | Hardcoded contactPointType to ContactPointAddress | |
| orderCustomer.party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| orderCustomer.party.contactPoints.addressLine1 | shippingAddress1 | The Address of individual | |
| orderCustomer.party.contactPoints.addressLine2 | shippingAddress2 | The Address of individual | |
| orderCustomer.party.contactPoints.cityName | shippingCity | The city name of individual | |
| orderCustomer.party.contactPoints.stateProvinceName | shippingRegion | The state name of individual | |
| orderCustomer.party.contactPoints.countryName | shippingCountry | The country name of individual | |
| orderCustomer.party.contactPoints.postalCodeText | shippingPostalCode | The postalCode name of individual | |
| orderCustomer.party.contactPoints.id | null | Hardcoded Id to null | |
| orderCustomer.party.contactPoints.name | addressId | The address Id | |
| orderCustomer.party.contactPoints.contactPointType | ContactPointPhone | Hardcoded contactPointType to ContactPointPhone | |
| orderCustomer.party.contactPoints.activeFromDate | Todays date | Individual active from date to todays date | |
| orderCustomer.party.contactPoints.telephoneNumber | contactPhone | The phone number of the individual | |
| orderCustomer.customerNumber | customerNumber | The Individual number of the individual | |
| orderCustomer.customerStatus | ACTIVE | The status of the customer | |
| orderProducts.adjustedGrossPrice | productLineItem.adjustedGrossPrice | Gross price for this product item | |
| orderProducts.adjustedNetPrice | productLineItem.adjustedNetPrice | Net price for this product item | |
| orderProducts.adjustedPrice | productLineItem.adjustedPrice | Final price for this product item | |
| orderProducts.adjustedTax | productLineItem.adjustedTax | Final tax amount for this product item | |
| orderProducts.isBonusProduct | productLineItem.bonusProductLineItem | Indicates whether this is a bonus item or not | |
| orderProducts.isBundledProduct | productLineItem.bundledProductLineItem | Indicates whether this product is bundled with another or not | |
| orderProducts.isGift | productLineItem.gift | Indicates whether this item is a gift or not | |
| orderProducts.giftMessage | productLineItem.giftMessage | Message to include on a gift item | |
| orderProducts.positionIndex | productLineItem.position | Position of this product item in the list | |
| orderProducts.productId | productLineItem.productID | The B2C product identifier for this item | |
| orderProducts.productName | productLineItem.productName | The name of the product | |
| orderProducts.quantityUnit | productLineItem.quanity.unit | The unit of measure for the quantity value | |
| orderProducts.quantityValue | productLineItem.quantityValue | The actual quantity | |
| externalIds.id | null | Hardcoded Id to null | |
| externalIds.externalId | customerNumber | The external Id of the SALESFORCE_B2C | |
| externalIds.externalIdType | SALESFORCE_B2C | The externalIdtype of SALESFORCE_B2C | |
| externalIds.status | VALID | The status of the customer | |
| auditInfo.createdBy | createdBy | The Individual created by user | |
| auditInfo.updatedBy | updatedBy | The individual last updated user | |
| auditInfo.updatedDate | updatedDate | The last Modified date of the individual | |
| auditInfo.createdDate | createdDate | The creation Date of the individual | |
| auditInfo.isDeleted | false | Indicates whether or not the entity has been deleted defaulted to false |
map-inventory-query-response
Inventory Response Mapping
Source:
./src/main/resources/dwl/map-inventory-query-response.dwl
Mapping Tables
Maps CIM inventory response to B2C
| B2C | CIM | Description |
|---|---|---|
| productId | productId | The ID of the Product |
| productName | productName | Name of the Product |
| availableStock | quantityInStock | Quantity available for the Product |
| storeId | locationId | The ID of the store where the Product is located |